版本：V4.0

員工管理API

獲取員工權限列表

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
page_size	Integer	Body	是	每頁數量
page_index	Integer	Body	是	當前頁數

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
staff_access_id	String	Body	員工權限ID
staff_access_name	String	Body	員工權限名稱
created_time	String	Body	創建時間，UTC
faces	[]Object<face>	Body	人臉信息
pin_codes	[]Object<pin_code>	Body	PIN碼信息
rf_cards	[]Object<rf_card>	Body	射頻卡信息
access_groups	[]Object<access_group>	Body	權限組信息
floor_accesses	[]Object<floor_access>	Body	樓層權限信息

face說明

參數名	類型	位置	說明
face_id	String	Body	人臉ID

pin_code說明

參數名	類型	位置	說明
pin_code_id	String	Body	PIN碼ID
number	String	Body	號碼

rf_card說明

參數名	類型	位置	說明
rf_card_id	String	Body	射頻卡ID
number	String	Body	號碼

access_group說明

參數名	類型	位置	說明
access_group_name	String	Body	權限組名稱

floor_access說明

參數名	類型	位置	說明
building_name	String	Body	樓棟名稱
floor_access	[]String	Body	樓層權限

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_staff_access_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "staff_access_id": "sx9a621c1ae77040d697bd2134700f57e",
      "staff_access_name": "test",
      "created_time": "2024-02-19 17:02:23",
      "faces": [
        {
          "face_id": "fbr2c4b070cc928496198944858b344fc"
        }
      ],
      "pin_codes": [
        {
          "pin_code_id": "pbr2c4b070cc928496198944858b344fc",
          "number": "123456"
        }
      ],
      "rf_cards": [
        {
          "rf_card_id": "rbr2c4b070cc928496198944858b344fc",
          "number": "123456"
        }
      ],
      "access_groups": [
        {
          "access_group_name": "test"
        }
      ],
      "floor_accesses": [
        {
          "building_name": "AB01",
          "floor_access": [
            "1",
            "2"
          ]
        }
      ]
    }
  ]
}

失敗返回示例

見接口失敗返回

獲取員工權限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
staff_access_id	String	Body	是	員工權限ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
staff_access_name	String	Body	員工權限名稱
created_time	String	Body	創建時間，UTC
faces	[]Object<face>	Body	人臉信息
pin_codes	[]Object<pin_code>	Body	PIN碼信息
rf_cards	[]Object<rf_card>	Body	射頻卡信息
access_groups	[]Object<access_group>	Body	權限組信息
floor_accesses	[]Object<floor_access>	Body	樓層權限信息

face說明

參數名	類型	位置	說明
face_id	String	Body	人臉ID

pin_code說明

參數名	類型	位置	說明
pin_code_id	String	Body	PIN碼ID
number	String	Body	號碼

rf_card說明

參數名	類型	位置	說明
rf_card_id	String	Body	射頻卡ID
number	String	Body	號碼

access_group說明

參數名	類型	位置	說明
access_group_id	String	Body	權限組ID
access_group_name	String	Body	權限組名稱
access_group_type	String	Body	權限組類型 system：系統 customized：定製

floor_access說明

參數名	類型	位置	說明
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱
floor_access	[]String	Body	樓層權限

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_staff_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "staff_access_id": "sx9a621c1ae77040d697bd2134700f57e",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "staff_access_name": "test",
    "created_time": "2024-02-19 17:02:23",
    "faces": [
      {
        "face_id": "fbr2c4b070cc928496198944858b344fc"
      }
    ],
    "pin_codes": [
      {
        "pin_code_id": "pbr2c4b070cc928496198944858b344fc",
        "number": "123456"
      }
    ],
    "rf_cards": [
      {
        "rf_card_id": "rbr2c4b070cc928496198944858b344fc",
        "number": "123456"
      }
    ],
    "access_groups": [
      {
        "access_group_name": "test",
        "access_group_id": "arbr2c4b070cc928496198944858b344f",
        "access_group_type": "system"
      }
    ],
    "floor_accesses": [
      {
        "building_id": "b1a621c1ae77040d697bd2134700f57ee",
        "building_name": "AB01",
        "floor_access": [
          "1",
          "2"
        ]
      }
    ]
  }
}

失敗返回示例

見接口失敗返回

創建員工權限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
staff_access_name	String	Body	是	員工權限名稱
faces	[]Object<face>	Body	否	人臉信息
pin_codes	[]Object<pin_code>	Body	否	PIN碼信息
rf_cards	[]Object<rf_card>	Body	否	射頻卡信息
access_groups	[]Object<access_group>	Body	是	權限組信息
floor_accesses	[]Object<floor_access>	Body	否	樓層權限信息

face說明

參數名	類型	位置	必填	說明
face_picture_url	String	Body	是	人臉圖片地址

pin_code說明

參數名	類型	位置	必填	說明
number	String	Body	是	號碼

rf_card說明

參數名	類型	位置	必填	說明
number	String	Body	是	號碼

access_group說明

參數名	類型	位置	必填	說明
access_group_id	String	Body	是	權限組ID

floor_access說明

參數名	類型	位置	必填	說明
building_id	String	Body	是	樓棟ID
floor_access	[]String	Body	是	樓層權限

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
staff_access_id	String	Body	員工權限ID

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_staff_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "staff_access_name": "test",
    "faces": [
      {
        "face_picture_url": "https://akcs.akubela.com/test"
      }
    ],
    "pin_codes": [
      {
        "number": "123456"
      }
    ],
    "rf_cards": [
      {
        "number": "123456"
      }
    ],
    "access_groups": [
      {
        "access_group_id": "arbr2c4b070cc928496198944858b344f"
      }
    ],
    "floor_accesses": [
      {
        "building_id": "b1a621c1ae77040d697bd2134700f57ee",
        "floor_access": [
          "1",
          "2"
        ]
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "staff_access_id": "s2a621c1ae77040d697bd2134700f57ea"
  }
}

失敗返回示例

見接口失敗返回

更新員工權限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
staff_access_id	String	Body	是	員工權限ID
staff_access_name	String	Body	是	員工權限名稱
faces	[]Object<face>	Body	否	人臉信息
pin_codes	[]Object<pin_code>	Body	否	PIN碼信息
rf_cards	[]Object<rf_card>	Body	否	射頻卡信息
access_groups	[]Object<access_group>	Body	是	權限組信息
floor_accesses	[]Object<floor_access>	Body	否	樓層權限信息

face說明

參數名	類型	位置	必填	說明
face_picture_url	String	Body	是	人臉圖片地址
is_deleted	Boolean	Body	是	判斷圖片是否刪除 true：已刪除 false：未刪除

pin_code說明

參數名	類型	位置	必填	說明
number	String	Body	是	號碼

rf_card說明

參數名	類型	位置	必填	說明
number	String	Body	是	號碼

access_group說明

參數名	類型	位置	必填	說明
access_group_id	String	Body	是	權限組ID

floor_access說明

參數名	類型	位置	必填	說明
building_id	String	Body	是	樓棟ID
floor_access	[]String	Body	是	樓層權限

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_staff_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "staff_access_id": "s2a621c1ae77040d697bd2134700f57ea",
    "staff_access_name": "test",
    "faces": [
      {
        "face_picture_url": "https://akcs.akubela.com/test",
        "is_deleted": false
      }
    ],
    "pin_codes": [
      {
        "number": "123456"
      }
    ],
    "rf_cards": [
      {
        "number": "123456"
      }
    ],
    "access_groups": [
      {
        "access_group_id": "arbr2c4b070cc928496198944858b344f"
      }
    ],
    "floor_accesses": [
      {
        "building_id": "b1a621c1ae77040d697bd2134700f57ee",
        "floor_access": [
          "1",
          "2"
        ]
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

刪除員工權限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
staff_access_id	String	Body	是	員工權限ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_staff_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "staff_access_id": "srbr2c4b070cc928496198944858b344f"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

批量刪除員工權限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
staff_accesses	[]Object<staff_access>	Body	是	員工權限信息

staff_access說明

參數名	類型	位置	必填	說明
staff_access_id	String	Body	是	員工權限ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_staff_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p01adc223cc4b3bedb6bd4742dedcfa52",
    "staff_accesses": [
      {
        "staff_access_id": "s8b5a73f8dd84abaa94dcs248be49b0d1"
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

導入員工權限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
file_name	String	Body	是	文件名稱
file_url	String	Body	是	文件地址

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
task_id	String	Body	任務ID

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "import_staff_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "file_name": "test",
    "file_url": "https://test.akubela.com/test-staff"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
  }
}

失敗返回示例

見接口失敗返回

獲取員工權限列表​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

face說明​

pin_code說明​

rf_card說明​

access_group說明​

floor_access說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取員工權限信息​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

face說明​

pin_code說明​

rf_card說明​

access_group說明​

floor_access說明​

請求示例​

成功返回示例​

失敗返回示例​

創建員工權限信息​

接口地址​

請求參數​

param說明​

face說明​

pin_code說明​

rf_card說明​

access_group說明​

floor_access說明​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

更新員工權限信息​

接口地址​

請求參數​

param說明​

face說明​

pin_code說明​

rf_card說明​

access_group說明​

floor_access說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

刪除員工權限信息​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

批量刪除員工權限信息​

接口地址​

請求參數​

param說明​

staff_access說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

導入員工權限信息​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

請求示例​

成功返回示例​

獲取員工權限列表

接口地址

請求參數

param說明

返回參數

result說明

face說明

pin_code說明

rf_card說明

access_group說明

floor_access說明

請求示例

成功返回示例

失敗返回示例

獲取員工權限信息

接口地址

請求參數

param說明

返回參數

result說明

face說明

pin_code說明

rf_card說明

access_group說明

floor_access說明

請求示例

成功返回示例

失敗返回示例

創建員工權限信息

接口地址

請求參數

param說明

face說明

pin_code說明

rf_card說明

access_group說明

floor_access說明

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

更新員工權限信息

接口地址

請求參數

param說明

face說明

pin_code說明

rf_card說明

access_group說明

floor_access說明

返回參數

請求示例

成功返回示例

失敗返回示例

刪除員工權限信息

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

批量刪除員工權限信息

接口地址

請求參數

param說明

staff_access說明

返回參數

請求示例

成功返回示例

失敗返回示例

導入員工權限信息

接口地址

請求參數

param說明

返回參數

result說明

請求示例

成功返回示例